Utility.getMetricSetPlacementsByUniqueName Method

Gets an object with the metric set's element usage unique names as properties and location information as values.
 

Parameters

metricSet

Type: MetricSet
The Metric Set.
request

Type: Request
The most recent data request, if available, for taking into account parameter values and overrides.
Optional: True

Return Value


Type: Object
A plain object with element usage unique names as properties, each with plain objects as values
 with properties:
     placement               [type: dundas.data.PlacementPosition]                   - The placement of the analysis element usage corresponding with its location in the cellset.
     index                   [type: Number, integer: true, mayBeNull: true]          - The index of the analysis element usage within its placement in the metric set, or the cellset in case measures are hidden.
     isDynamic               [type: Boolean, optional: true]                         - Indicates whether the measure or hierarchy is a placeholder and can be changed dynamically.
     caption                 [type: String]                                          - The analysis element usage caption.
     analysisElementCaption  [type: String]                                          - The analysis element caption.
     tuplePlacement          [type: dundas.data.PlacementPosition, mayBeNull: true]  - The placement of measures in the cellset: either rows or columns.
     parameterId             [type: String, optional: true]                          - The parameter ID of a slicer hierarchy.
     parameterValue          [type: dundas.data.ParameterValue, mayBeNull: true]     - The parameter value of a slicer hierarchy.
     slicerParameters        [type: Array, elementType: Object, mayBeNull: true]     - The parameter information for a parallel slicer measure.
         id                  [type: String]                                          - The parameter ID.
         caption             [type: String]                                          - The caption representing the slicer parameter.
         value               [type: dundas.data.ParameterValue, mayBeNull: true]     - The current parameter value.